home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / etc / Pfs_OpenConnection.man < prev    next >
Text File  |  1989-01-27  |  2KB  |  61 lines
  1. '\" Copyright 1989 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/lib/forms/RCS/proto.man,v 1.3 89/01/09 11:43:01 ouster Exp $ SPRITE (Berkeley)
  10. '\" 
  11. .so \*(]ltmac.sprite
  12. .HS Pfs_OpenConnection libcalls
  13. .BS
  14. .SH NAME
  15. Pfs_OpenConnection \- Create a pseudo-device connection to a pseudo-file-system
  16. .SH SYNOPSIS
  17. .nf
  18. \fB#include <pdev.h>\fR
  19. Pdev_Stream *
  20. \fBPfs_OpenConnection\fR(\fIpfsToken, idSize, idPtr, service\fR)
  21. .SH ARGUMENTS
  22. .AS ClientData *fileIDPtr
  23. .AP Pfs_Token *pfsToken in
  24. Return value of \fBPfs_Open\fP call.
  25. .AP int idSize in
  26. Size of the ID.
  27. .AP Address idPtr in
  28. Pointer to server's name for this connection.
  29. .AP Pdev_Callbacks *service in
  30. Array of pseudo-device call-back procedures.
  31. .BE
  32.  
  33. .SH DESCRIPTION
  34. .PP
  35. \fBPfs_OpenConnection\fP is used to establish a pseudo-device connection
  36. in response to an open request to a pseudo-file-system server.
  37. The \fIpfsToken\fP argument is the return value of the \fBPfs_Open\fP call
  38. used to establish the server of the pseudo-file-system.
  39. The \fIidPtr\fP references the server's identifier for the pseudo-device
  40. connection.  If the file being opened is a directory then this
  41. identifier may be passed back as the \fBprefixID\fP for
  42. naming operations that are relative to the directory.
  43. The \fIservice\fP argument is a set of call-back procedures that
  44. are invoked by the Pdev library in response to subsequent operations
  45. on the file.  See the \fBPdev_Open\fP man page for a description
  46. of how these call-backs are invoked.  Any of the elements of \fIservice\fP
  47. can be NULL pointers in which case a default, no-op handler is used
  48. by the Pdev library.
  49. .PP
  50. The return value of \fBPfs_OpenConnection\fP is a token for the
  51. connection.  It contains the streamID of the server's half of the
  52. connection on which various I/O controls can be done.  It also
  53. contains a \fBclientData\fP field for use by the caller of
  54. \fBPfs_OpenConnection\fP.  This token is passed into all of the
  55. pseudo-device service call-backs.
  56. .SH SEE ALSO
  57. Pfs_Open, Pdev_SetHandler, pdev
  58. .SH KEYWORDS
  59. pseudo-device, pseudo-file-system, call-back
  60.  
  61.